home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / u_man / cat1 / insightAdmin.z / insightAdmin
Encoding:
Text File  |  2002-10-03  |  14.0 KB  |  265 lines
  1.  
  2.  
  3.  
  4. IIIINNNNSSSSIIIIGGGGHHHHTTTTAAAADDDDMMMMIIIINNNN((((1111))))                                                IIIINNNNSSSSIIIIGGGGHHHHTTTTAAAADDDDMMMMIIIINNNN((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      insightAdmin - Online Documentation Administration Utility
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      insightAdmin [ -v ] [ -h ] [ -c ] [ -d ] bookshelf_path
  13.  
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      The _i_n_s_i_g_h_t_A_d_m_i_n utility is used to maintain the library of online books
  17.      available to the _i_n_f_o_s_e_a_r_c_h(_1) and _s_g_i_h_e_l_p(_1) viewing technologies.
  18.  
  19.      This utility program will update the list of books available on any
  20.      particular (specified) bookshelf. This list is created/stored in the file
  21.      <<<<bbbbooooooookkkksssshhhheeeellllffff____ppppaaaatttthhhh>>>>////bbbbooooooookkkklllliiiisssstttt....ttttxxxxtttt. It also constructs library and bookshelf-
  22.      level HTML files which can be browsed using any WWW (web) browser or
  23.      through the IRIX Interactive Desktop.
  24.  
  25.      After the installation or removal of book(s) via the _i_n_s_t(_1_M) command,
  26.      _i_n_s_t automatically runs the _i_n_s_i_g_h_t_A_d_m_i_n command on the necessary
  27.      bookshelf.
  28.  
  29.      An administrator will need to run _i_n_s_i_g_h_t_A_d_m_i_n:
  30.  
  31.      o    When books have been removed via the _r_m(_1) command, or by some means
  32.           other than using _i_n_s_t(_1_M) (the standard process).
  33.  
  34.      o    To convert any books that may be in the old (unreadable) Insight
  35.           format. See the discussion of the ----cccc option below.
  36.  
  37.      o    If they feel as though the online documentation library is out-of-
  38.           sync (for some reason).
  39.  
  40.      In any of the cases listed above, the administrator should then run
  41.      _i_n_s_i_g_h_t_A_d_m_i_n on the necessary bookshelf(s) using the appropriate
  42.      command-line options.
  43.  
  44. DDDDEEEEFFFFIIIINNNNIIIITTTTIIIIOOOONNNNSSSS
  45.      A bbbbooooooookkkksssshhhheeeellllffff is defined as a directory containing a set of books. By
  46.      default, bookshelves are located in:
  47.  
  48.        ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////SSSSGGGGIIII____bbbbooooooookkkksssshhhheeeellllvvvveeeessss
  49.  
  50.      To examine a sample bookshelf, look under this default path. Most of the
  51.      directories contained under this area are defined as bbbbooooooookkkksssshhhheeeellllvvvveeeessss. By
  52.      convention, below each of those bbbbooooooookkkksssshhhheeeellllffff directories exists a
  53.      subdirectory named "bbbbooooooookkkkssss". The "bbbbooooooookkkkssss" subdirectory contains all
  54.      available online books for this bbbbooooooookkkksssshhhheeeellllffff.
  55.  
  56.      For example, examining the path:
  57.  
  58.        ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////SSSSGGGGIIII____bbbbooooooookkkksssshhhheeeellllvvvveeeessss////SSSSGGGGIIII____EEEEnnnnddddUUUUsssseeeerrrr////bbbbooooooookkkkssss////DDDDeeeesssskkkkttttoooopppp____UUUUGGGG
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. IIIINNNNSSSSIIIIGGGGHHHHTTTTAAAADDDDMMMMIIIINNNN((((1111))))                                                IIIINNNNSSSSIIIIGGGGHHHHTTTTAAAADDDDMMMMIIIINNNN((((1111))))
  71.  
  72.  
  73.  
  74.      SSSSGGGGIIII____EEEEnnnnddddUUUUsssseeeerrrr is the bbbbooooooookkkksssshhhheeeellllffff and DDDDeeeesssskkkkttttoooopppp____UUUUGGGG is the bbbbooooooookkkk.
  75.  
  76.  
  77. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  78.      Command line options are described below.
  79.  
  80.      -a   The -a option is no longer needed and is ignored.
  81.  
  82.      -c   The -c option instructs _i_n_s_i_g_h_t_A_d_m_i_n to ccccoooonnnnvvvveeeerrrrtttt any books on the
  83.           specified bookshelf that cannot be read (old format books). By
  84.           default, this conversion is accomplished by sending the book through
  85.           a local filtering process.
  86.  
  87.           Optionally, downloading the "packaged" book(s) from the SSSSiiiilllliiiiccccoooonnnn
  88.           GGGGrrrraaaapppphhhhiiiiccccssss TTTTeeeecccchhhhnnnniiiiccccaaaallll PPPPuuuubbbblllliiiiccccaaaattttiiiioooonnnnssss LLLLiiiibbbbrrrraaaarrrryyyy website
  89.           (http://techpubs.sgi.com) can be initiated if the ----dddd option is
  90.           specified. If (for some reason) the download fails, then the local
  91.           filtering process is attempted upon the book(s) that encountered
  92.           problems.
  93.  
  94.           Note that this conversion stage may take some time and should be
  95.           used with caution. The amount of time varies with the number and
  96.           size of the book(s) that need to be converted (could be from 1 to 3
  97.           minutes or more per book).
  98.  
  99.           If you wish to first determine which books need to be converted
  100.           and/or which bookshelves to run the _i_n_s_i_g_h_t_A_d_m_i_n command on, you can
  101.           first run _i_n_s_i_g_h_t_A_d_m_i_n in verbose mode (using the default online
  102.           documentation library path, which will check aaaallllllll bookshelves):
  103.  
  104.             iiiinnnnssssiiiigggghhhhttttAAAAddddmmmmiiiinnnn ----vvvv
  105.  
  106.      -d   The -d option instructs _i_n_s_i_g_h_t_A_d_m_i_n to attempt to ddddoooowwwwnnnnllllooooaaaadddd
  107.           "packaged" book(s) as part of a ccccoooonnnnvvvveeeerrrrssssiiiioooonnnn operation (see ----cccc). Books
  108.           are downloaded from the SSSSiiiilllliiiiccccoooonnnn GGGGrrrraaaapppphhhhiiiiccccssss TTTTeeeecccchhhhnnnniiiiccccaaaallll PPPPuuuubbbblllliiiiccccaaaattttiiiioooonnnnssss
  109.           LLLLiiiibbbbrrrraaaarrrryyyy website (http://techpubs.sgi.com).
  110.  
  111.           The ggggeeeettttuuuurrrrllll((((1111)))) command is used in conjunction with this operation.
  112.           Note that if you utilize a proxy server, the communication library
  113.           ggggeeeettttuuuurrrrllll((((1111)))) employs may need to be configured properly.  This can be
  114.           done through the webcontrol panel.  See wwwweeeebbbbccccoooonnnnttttrrrroooollll((((1111)))) for details.
  115.  
  116.      -f   The -f option instructs _i_n_s_i_g_h_t_A_d_m_i_n to force the addition or
  117.           replacement of each book's title to the bookshelf's list of book
  118.           titles (booklist.txt). The -f option is no longer needed and is
  119.           ignored.
  120.  
  121.      -h   The -h option instructs _i_n_s_i_g_h_t_A_d_m_i_n to print its usage message.
  122.  
  123.      -l   The -l lllliiiibbbb____ppppaaaatttthhhh option is no longer needed and is ignored.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. IIIINNNNSSSSIIIIGGGGHHHHTTTTAAAADDDDMMMMIIIINNNN((((1111))))                                                IIIINNNNSSSSIIIIGGGGHHHHTTTTAAAADDDDMMMMIIIINNNN((((1111))))
  137.  
  138.  
  139.  
  140.      -v   The -v option instructs _i_n_s_i_g_h_t_A_d_m_i_n to output additional
  141.           information.  This includes warnings about "old/unreadable format"
  142.           books. If this warning occurs, you should consider installing a new
  143.           copy of the book (if available), or re-run _i_n_s_i_g_h_t_A_d_m_i_n with the
  144.           ccccoooonnnnvvvveeeerrrrssssiiiioooonnnn option(s): -c and (if so desired) -d. By default,
  145.           _i_n_s_i_g_h_t_A_d_m_i_n runs silently.
  146.  
  147.      bbbbooooooookkkksssshhhheeeellllffff____ppppaaaatttthhhh
  148.           The bbbbooooooookkkksssshhhheeeellllffff____ppppaaaatttthhhh option specifies the bookshelf on which to run
  149.           the administration tool. If this option is not specified,
  150.           _i_n_s_i_g_h_t_A_d_m_i_n will work on aaaallllllll bookshelves below the default online
  151.           documentation library path:
  152.  
  153.           ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////SSSSGGGGIIII____bbbbooooooookkkksssshhhheeeellllvvvveeeessss////
  154.  
  155.  
  156. FFFFIIIILLLLEEEESSSS
  157.      /usr/sbin/insightAdmin
  158.  
  159.  
  160. EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
  161.      Update the SGI_EndUser bookshelf.
  162.  
  163.        iiiinnnnssssiiiigggghhhhttttAAAAddddmmmmiiiinnnn ----vvvv ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////SSSSGGGGIIII____bbbbooooooookkkksssshhhheeeellllvvvveeeessss////SSSSGGGGIIII____EEEEnnnnddddUUUUsssseeeerrrr
  164.  
  165.      Convert any old-format books found on the SGI_Admin bookshelf to the new
  166.      format.
  167.  
  168.        iiiinnnnssssiiiigggghhhhttttAAAAddddmmmmiiiinnnn ----vvvv ----cccc ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////SSSSGGGGIIII____bbbbooooooookkkksssshhhheeeellllvvvveeeessss////SSSSGGGGIIII____AAAAddddmmmmiiiinnnn
  169.  
  170.      Activate the download option (from http://techpubs.sgi.com) when
  171.      converting any old-format books found on the Help bookshelf to the new
  172.      format.
  173.  
  174.        iiiinnnnssssiiiigggghhhhttttAAAAddddmmmmiiiinnnn ----vvvv ----cccc ----dddd ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////SSSSGGGGIIII____bbbbooooooookkkksssshhhheeeellllvvvveeeessss////HHHHeeeellllpppp
  175.  
  176.  
  177. NNNNOOOOTTTTEEEESSSS
  178.      To bbbbrrrroooowwwwsssseeee the available bookshelves and books on the local system, in
  179.      your web browser or in the IRIX Interactive Desktop File Manager, open
  180.      the following file:
  181.  
  182.        ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////SSSSGGGGIIII____bbbbooooooookkkksssshhhheeeellllvvvveeeessss////iiiinnnnddddeeeexxxx....hhhhttttmmmmllll
  183.  
  184.      Localized books can be browsed by opening the following file:
  185.  
  186.        ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////<<<<llllaaaannnngggguuuuaaaaggggeeee>>>>____bbbbooooooookkkksssshhhheeeellllvvvveeeessss////iiiinnnnddddeeeexxxx....hhhhttttmmmmllll
  187.  
  188.      Specifically, here is one such file (available only if localized books
  189.      have been installed):
  190.  
  191.        ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////ffffrrrr____bbbbooooooookkkksssshhhheeeellllvvvveeeessss////iiiinnnnddddeeeexxxx....hhhhttttmmmmllll
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. IIIINNNNSSSSIIIIGGGGHHHHTTTTAAAADDDDMMMMIIIINNNN((((1111))))                                                IIIINNNNSSSSIIIIGGGGHHHHTTTTAAAADDDDMMMMIIIINNNN((((1111))))
  203.  
  204.  
  205.  
  206.      If you see warnings about books in an "old/unreadable format", those
  207.      books can be converted using the ----cccc and (optionally) the ----dddd option(s).
  208.      Additional information can be found in the iiiinnnnssssiiiigggghhhhtttt Release Notes.
  209.  
  210.  
  211. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  212.      _i_n_f_o_s_e_a_r_c_h(_1), _s_g_i_h_e_l_p(_1), _i_n_s_i_g_h_t(_1), _g_e_t_u_r_l(_1)
  213.  
  214.      iiiinnnnssssiiiigggghhhhtttt Release Notes.
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.                                                                         PPPPaaaaggggeeee 4444
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.